---
title: "Create Biometric Authentication"
method: POST
path: "/v1/clients/{clientId}/verifications (Biometric Authentication)"
tags: ["Biometric Authentication"]
---

# Create Biometric Authentication

`POST /v1/clients/{clientId}/verifications (Biometric Authentication)`

Use this endpoint to create a Biometric Authentication case with the `clientId` from a previous successful Identity Verification case. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> **Important:** Before using this endpoint, see the <a href="https://docs.fourthline.com/docs/clientauth-integration-api">integration guide</a>. <br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left" alt="Note" /> **Note:** Client Authentication has been renamed to Biometric Authentication. Biometric Authentication is supported in both V1 and v2 integrations.

## Path parameters

- `clientId` string, required

## Headers

- `Authorization` string, required — The `access_token` returned in your most recent [Create access token](https://docs.fourthline.com/reference/create-access-token) response.

## Request body

- object
  - `providerProcessId` string, required — Your unique identifier for the case. <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> **Tip:** To create multiple cases for the same `clientId`, you must specify a unique `providerProcessId` for each separate case.
  - `processType` string, required — The case type: `ClientConfirmation`= Biometric Authentication case
  - `branch` string — Your configuration for this product. <br />Set the string provided by your Fourthline delivery manager.<br />If **not** set, we use your default configuration. <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> **Tip:** Use this parameter for case configuration in older setups.
  - `clientData` object, required — The client’s <Glossary>identity data</Glossary>.
    - `person` object — The client’s <Glossary>personal data</Glossary>. <br /><br />Requirements: For API integration object is required.
      - `type` string, required — The type of entity the client is. <br />Enum: <br />• `Legal Entity`: The client is a company or organization with legal rights and obligations. <br />• `Legal Person`: The client is a non-human entity with legal rights and obligations. <br />• `Natural Person`: The client is a living human.
      - `name` string — The client’s full name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: John James Smith <br /><img src="https://files.readme.io/5c5228a-Inline_Configurable.svg" align="left"/> **Configurable**: You can configure this parameter to be required or optional on request
      - `initials` string — The client’s initials. <br /><br />Format: Alphabetical characters <br /><br />Example: JCCF
      - `firstName` string — The client’s first name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: John
      - `middleName` string — The client’s middle name(s). <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: James
      - `lastName` string — The client’s last name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Smith
      - `otherLastName` string — Any other last name the client uses, e.g. married name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes
      - `nationality` string — The client’s nationality. <br /><br />Format: ISO 3166-1 alpha-3 country code <br /><br />Example: BEL
      - `gender` 'Female' | 'Male' | 'Other' | 'Unknown' — The client’s sex <br /><br />Format: Case sensitive <br />Enum: <br />• `Female`: Female in line with ID document <br />• `Male`: Male in line with ID document <br />• `Other`: ID document contains a value other than `Male` or `Female` <br />• `Unknown`: ID document contains **no** gender field
      - `birthDate` string — The client’s date of birth. <br /><br />Format: Date YYYY-MM-DD <br /><br />Example: `1960-10-18`= October 18, 1960
      - `placeOfBirth` string — The city where the client was born. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Sint-Agatha-Berchem <br /><img src="https://files.readme.io/5c5228a-Inline_Configurable.svg" align="left"/> **Configurable**: You can configure this parameter to be required or optional on request
      - `countryOfBirth` string — The country where the client was born. <br /><br />Format: ISO 3166-1 alpha-3 <br /><br />Example: BEL
    - `address` object — The client’s address details. <br /><br />Requirements: For API integration that upload `person` and `emailAndPhone` data.
      - `street` string — The street of the client’s address. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Rue Jean-Baptiste Jansen
      - `streetNumberPrefix` string — The prefix of the street number <br /><br />Example: A1
      - `streetNumber` integer — The street number of the client’s address. <br /><br />Format: int32 greater than or equal to zero
      - `streetNumberSuffix` string — The suffix of the street number. <br /><br />Format: Alphabetical characters, spaces, hyphens, and numerals <br /><br />Example: 123A
      - `postalCode` string — The zip code of the client’s address. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: 1082 <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/>**Note**: We use Google’s Address Validation API and depend on the quality of their data
      - `region` string — The region of the client’s address <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Brussels Capital Region
      - `city` string — The city of the client’s address. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: `London`
      - `country` string — The country of the client’s address. <br /><br />Format: ISO 3166-1 alpha-3 <br /><br />Example: BEL
    - `emailAndPhone` object — The client’s email address and phone number(s).
      - `email` string — The client’s email address. <br /><br />Format: Maximum 254 characters [_-a-zA-Z0-9.+]+@a-zA-Z0-9 <br /><br />Example: `j.smith@example.com`
      - `phone` string — The client’s landline number. <br /><br />Format: Must include the country code and begin with `00` or `+` **without** spaces <br /><br />Example: 003281123456 **or** +3281123456
      - `mobile` string — The client’s mobile phone number. <br /><br />Format: Must include the country code and begin with `00` or `+` **without** spaces <br /><br />Example: `00324123456789` **or** `+324123456789`
    - `deviceMetaData` object — The metadata from the client’s device.
      - `browserType` string — The type of browser the client’s device is using. <br /><br />Example: Google Chrome
      - `browserVersion` string — The version of the browser the client’s device is using. <br /><br />Example: 116.0.5845.172
      - `ipAddress` string — The IP address of the client’s device. <br /><br />Example: 185.128.27.102
      - `language` string — The language of the client’s device. <br /><br />Format: ISO 3166-1 alpha-2 <br /><br />Example: `NL`
      - `latitude` string — The latitude of the client’s device geolocation <br /><br />Format: Float between -90 and 90 <br /><br />Example: 45.464664
      - `longitude` string — The longitude of the client’s device geolocation. <br /><br />Format: Float between -180 and 180 <br /><br />Example: 9.188540
      - `model` string — The model of the client’s device. <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> **Tip:** **Required** for workflows that include Qualified Electronic Signature, so that we can check it matches the client’s Identity Verification case. <br /><br />Example: OnePlus Nord CE 5G
      - `osCompromised` string — Whether the operating system of the client’s device is compromised.
      - `osVersion` string — The version of the operating system of the client’s device. <br /><br />Example: Android 13
      - `region` string — The country code of the client’s device geolocation. <br /><br />Format: ISO 3166-1 alpha-2, e.g. `IT` **or** ISO 3166-1 alpha-3, e.g. `ITA`
      - `sdkVersion` string — The version of the SDK used. <br />Set to `v1`.
      - `analyticsId` string — The identifier for the metadata analytics.

## Response `201`

Biometric authentication created

- object
  - `verificationId` string — Our unique identifier for the case. <br /><br />Format: uuid string <br /><br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br />Validations: uuid format, `verificationId` exists <br />Errors: Format is incorrect or doesn’t exist
  - `providerProcessId` string — Your unique identifier for the case.
  - `status` string — The [case status](https://docs.fourthline.com/docs/biometricauth-statuses).

## Other responses

- `400` — Invalid request parameters
- `404` — Biometric authentication case not found
- `422` — The request could not be processed

---

[API](https://skmtc.net/fourthline/apis/fourthline-apis.md) · [All operations](https://skmtc.net/fourthline/apis/fourthline-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fourthline/fourthline-apis/revisions/7991ae7c8383/schema)
